[webview_flutter_wkwebview] Updates the internal wrapper to use `@ProxyApi` from pigeon #8311

bparrishMines · 2024-12-16T23:26:53Z

Also fixes flutter/flutter#152352

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

…n_proxy

bparrishMines · 2025-01-08T20:16:49Z

...es/webview_flutter/webview_flutter_wkwebview/darwin/Tests/HTTPCookieStoreProxyAPITests.swift

+    return instance
+  }
+
+  #if compiler(>=6.0)


@MainActor was required for local development with Xcode 16, but our CI doesn't recognize the method because it uses XCode 15. Related to: flutter/flutter#148870

Huh, I thought Swift 6 mode, with strict concurrency checking, was opt-in for Xcode 16.

bparrishMines · 2025-01-08T20:30:53Z

...w/darwin/webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/ProxyAPIRegistrar.swift

+  /// Creates an error when a method is called on an unsupported version.
+  func createUnsupportedVersionError(method: String, versionRequirements: String) -> PigeonError {
+    return PigeonError(
+      code: "FWFUnsupportedVersionError",


Keeps error code consistent with previous implementation.

bparrishMines · 2025-01-08T20:35:56Z

...webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/ScrollViewProxyAPIDelegate.swift

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#if os(iOS)


Note: These could be changed to canImport(UIKit) so that other platforms, like tvOS, could be used without changes. But I went with what was used in the Objective-C implementation.

bparrishMines · 2025-01-08T20:41:21Z

...view/darwin/webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/StructWrappers.swift

+///
+/// Since `URLRequest` is a struct, it is pass by value instead of pass by reference. This makes
+/// it not possible to modify the properties of a struct with the typical ProxyAPI system.
+class URLRequestWrapper {


Interesting FYI for anyone curious and additional context that I can add to the comment if needed:

The Swift URLRequest represents the Objective-C NSURLRequest and MutableNSURLRequest and converts to one or the other depending on the context.

This is different from URL and NSURL, which doesn't have a mutable equivalent. So a URL would always convert to the same NSURL instance when needed.

This distinction might come up when wrapping other structs.

bparrishMines · 2025-01-08T20:48:11Z

...flutter_wkwebview/Sources/webview_flutter_wkwebview/WebViewFlutterWKWebViewExternalAPI.swift

+/// change of the plugin. Native code other than this external API does not follow breaking change
+/// conventions, so app or plugin clients should not use any other native APIs.
+@objc(WebViewFlutterWKWebViewExternalAPI)
+public class FWFWebViewFlutterWKWebViewExternalAPI: NSObject {


This class was converted to Swift, but the @objc annotations should provide the equivalent method (I wrote the swift test before creating the class).

bparrishMines · 2025-01-08T20:50:32Z

packages/webview_flutter/webview_flutter_wkwebview/example/ios/Runner.xcodeproj/project.pbxproj

-		8FB79B842820A3A400C101D3 /* FWFUIDelegateHostApiTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = FWFUIDelegateHostApiTests.m; path = ../../darwin/Tests/FWFUIDelegateHostApiTests.m; sourceTree = SOURCE_ROOT; };
-		8FB79B8E2820BAB300C101D3 /* FWFScrollViewHostApiTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = FWFScrollViewHostApiTests.m; path = ../../darwin/Tests/FWFScrollViewHostApiTests.m; sourceTree = SOURCE_ROOT; };
-		8FB79B902820BAC700C101D3 /* FWFUIViewHostApiTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = FWFUIViewHostApiTests.m; path = ../../darwin/Tests/FWFUIViewHostApiTests.m; sourceTree = SOURCE_ROOT; };
-		8FB79B962821985200C101D3 /* FWFObjectHostApiTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; name = FWFObjectHostApiTests.m; path = ../../darwin/Tests/FWFObjectHostApiTests.m; sourceTree = SOURCE_ROOT; };


@stuartmorgan How were you able to get a relative path for the files in darwin/Tests? I had to manually change all the paths in this file.

If I'm doing it in the UI (sometimes I just edit the file manually instead), once they are moved I click on the broken file entry, press the folder icon under Location in the right-hand sidebar, select the file, then change the Location drop-down to "Relative to Project" (the last step is optional, but, I think project-relative makes the most sense).

…n_proxy

stuartmorgan

The Swift 5/6 #if duplications are pretty unfortunate; hopefully we won't be stuck in this situation for too long.

stuartmorgan · 2025-01-10T17:35:35Z

packages/webview_flutter/webview_flutter_wkwebview/CONTRIBUTING.md

+## Package Structure
+
+This plugin serves as a platform implementation plugin as outlined in [federated plugins](https://docs.flutter.dev/packages-and-plugins/developing-packages#federated-plugins).
+The sections below will provide an overview of how this plugin implements this portion with Android.


"with Android" -> "for iOS and macOS".

stuartmorgan · 2025-01-10T17:36:15Z

packages/webview_flutter/webview_flutter_wkwebview/CONTRIBUTING.md

+### Quick Overview
+
+This plugin implements the platform interface provided by `webview_flutter_platform_interface` using
+the native WebKit APIs for Android.


"WebKit APIs for Android" -> "WKWebView APIs".

stuartmorgan · 2025-01-10T17:37:13Z

packages/webview_flutter/webview_flutter_wkwebview/CONTRIBUTING.md

+
+##### 1. Ensure the project has been built at least once
+
+Run `flutter build ios --simulator` in `example/`.


Is this actually necessary to run pigeon? I would only expect to need flutter pub get.

stuartmorgan · 2025-01-10T17:38:06Z

packages/webview_flutter/webview_flutter_wkwebview/CONTRIBUTING.md

+needs to be done. Alternatively, it can be easier to update native code with the platform's specific
+IDE:
+
+Open `example/android/` in a separate Android Studio project.


Open example/ios/Runner.xcworkspace or example/macos/Runner.xcworkspace in Xcode.

stuartmorgan · 2025-01-10T18:01:08Z

...ges/webview_flutter/webview_flutter_wkwebview/example/macos/Runner.xcodeproj/project.pbxproj

@@ -27,30 +27,9 @@
 		33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; };
 		33CC10F62044A3C60003C045 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F42044A3C60003C045 /* MainMenu.xib */; };
 		33CC11132044BFA00003C045 /* MainFlutterWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC11122044BFA00003C045 /* MainFlutterWindow.swift */; };
-		33CF716F2C090A5900FB3AA4 /* FWFURLProtectionSpaceHostApiTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 33CF715A2C090A5800FB3AA4 /* FWFURLProtectionSpaceHostApiTests.m */; };


Did the Swift tests get dropped from the macOS project? I only see the removals here.

stuartmorgan · 2025-01-10T18:03:18Z

packages/webview_flutter/webview_flutter_wkwebview/lib/src/common/platform_webview.dart

+        return webView.addObserver(observer, keyPath, options);
+      case NSViewWKWebView():
+        return webView.addObserver(observer, keyPath, options);
+    }


All these switches to make identical calls are unfortunate. We'll need to think about better ways for interop systems to handle this kind of thing longer term.

stuartmorgan · 2025-01-10T18:30:37Z

packages/webview_flutter/webview_flutter_wkwebview/darwin/webview_flutter_wkwebview.podspec

-  s.source_files = 'webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/**/*.{h,m}'
-  s.public_header_files = 'webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/include/**/*.h'
-  s.module_map = 'webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/include/FlutterWebView.modulemap'
+  s.source_files = 'webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/**/*.{h,swift}'


Do we still have .h files?

stuartmorgan · 2025-01-10T18:32:17Z

packages/webview_flutter/webview_flutter_wkwebview/darwin/webview_flutter_wkwebview.podspec

  s.ios.dependency 'Flutter'
  s.osx.dependency 'FlutterMacOS'
  s.ios.deployment_target = '12.0'
  s.osx.deployment_target = '10.14'
  s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' }
  s.resource_bundles = {'webview_flutter_wkwebview_privacy' => ['webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/Resources/PrivacyInfo.xcprivacy']}
+  s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES', 'EXCLUDED_ARCHS[sdk=iphonesimulator*]' => 'i386' }


Do we still need EXCLUDE_ARCHS? I thought that was a legacy thing that we didn't need to include any more.

stuartmorgan · 2025-01-10T18:37:53Z

.../darwin/webview_flutter_wkwebview/Sources/webview_flutter_wkwebview/FlutterViewFactory.swift

+      let identifier: Int64 = args is Int64 ? args as! Int64 : Int64(args as! Int32)
+      let instance: AnyObject? = instanceManager.instance(forIdentifier: identifier)
+
+      if let instance = instance as? FlutterPlatformView {


Why do we not know what type the view identifier is for?

stuartmorgan · 2025-01-10T19:42:32Z

...es/webview_flutter/webview_flutter_wkwebview/darwin/Tests/HTTPCookieStoreProxyAPITests.swift

+    return instance
+  }
+
+  #if compiler(>=6.0)


Huh, I thought Swift 6 mode, with strict concurrency checking, was opt-in for Xcode 16.

bparrishMines added 30 commits November 11, 2024 16:22

generate proxy apis

c432fd0

start of trying to get swift to work

5948bf4

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

f75f6b1

…n_proxy

configure fixed it

859c3d3

formatted code

5496891

save these files i think

999bf22

remove modulemap

b5930f8

compiling code

913b245

create a wrapper for urlrequest

9dbf0a5

maybe finish controller

5050376

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

5135ffe

…n_proxy

start work on fixing tests

24f601f

fix some tests

2d7b482

fix navigation delegate tests

e1281ba

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

13dbc4d

…n_proxy

w;oiefj

bee1811

mock

ff64f90

half of the tests

419a2eb

some more test fixes

1740a29

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

389788e

…n_proxy

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

40ae802

…n_proxy

more test fixes

13fc34c

finish controller tests

b15cdde

cookie manager tests

7dcc650

widget tests

0d22adf

fix legacy implementation

a35c48e

legacy cookie tests

f0fc827

first test in webview widget passed

e6fe379

initial url test

6494a65

more fixed tests

07f3410

bparrishMines added 2 commits December 20, 2024 15:01

any again

95b6cc5

faoiwej

122524c

github-actions bot removed the p: interactive_media_ads Plugin for IMA SDK label Dec 20, 2024

bparrishMines added 5 commits December 20, 2024 19:17

alternative to main actor

9f4de6b

use ifdefs for xcode 5.0

926f4d0

fix legacy

8ae290e

values yo

46bc96b

fix mocks

d335c3a

bparrishMines mentioned this pull request Dec 23, 2024

[webview_flutter] Contributions require special tooling flutter/flutter#152352

Open

bparrishMines added 4 commits January 7, 2025 16:59

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

0481342

…n_proxy

try move tests

7600657

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

4472130

…n_proxy

manual update

7e4d554

bparrishMines marked this pull request as ready for review January 8, 2025 19:52

bparrishMines requested a review from cbracken as a code owner January 8, 2025 19:52

bparrishMines changed the title ~~Webview darwin proxy~~ [webview_flutter_wkwebview] Updates the internal wrapper to use @ProxyApi from pigeon Jan 8, 2025

tests pass now idk

a3e7538

bparrishMines commented Jan 8, 2025

View reviewed changes

bparrishMines added 2 commits January 8, 2025 15:55

fix external api name

854e470

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

a53db25

…n_proxy

bparrishMines requested review from stuartmorgan and removed request for cbracken January 8, 2025 21:23

bparrishMines mentioned this pull request Jan 9, 2025

[webview_flutter_android] Add additional WebSettings methods #8270

Open

11 tasks

bparrishMines added 6 commits January 8, 2025 21:49

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

976750a

…n_proxy

fix onCanGoBackChange

59254d7

add scrollview methods

c0d3558

add other directional bounces

d0847df

Merge branch 'main' of github.com:flutter/packages into webview_darwi…

0798846

…n_proxy

support xcode 15 i think

27a409e

stuartmorgan reviewed Jan 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[webview_flutter_wkwebview] Updates the internal wrapper to use `@ProxyApi` from pigeon #8311

[webview_flutter_wkwebview] Updates the internal wrapper to use `@ProxyApi` from pigeon #8311

bparrishMines commented Dec 16, 2024 •

edited

Loading

bparrishMines Jan 8, 2025

stuartmorgan Jan 10, 2025

bparrishMines Jan 8, 2025

bparrishMines Jan 8, 2025

bparrishMines Jan 8, 2025

bparrishMines Jan 8, 2025 •

edited

Loading

bparrishMines Jan 8, 2025

stuartmorgan Jan 10, 2025

stuartmorgan left a comment

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025

stuartmorgan Jan 10, 2025


		##### 1. Ensure the project has been built at least once

		Run `flutter build ios --simulator` in `example/`.

[webview_flutter_wkwebview] Updates the internal wrapper to use @ProxyApi from pigeon #8311

Are you sure you want to change the base?

[webview_flutter_wkwebview] Updates the internal wrapper to use @ProxyApi from pigeon #8311

Conversation

bparrishMines commented Dec 16, 2024 • edited Loading

Pre-launch Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bparrishMines Jan 8, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stuartmorgan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

[webview_flutter_wkwebview] Updates the internal wrapper to use `@ProxyApi` from pigeon #8311

[webview_flutter_wkwebview] Updates the internal wrapper to use `@ProxyApi` from pigeon #8311

bparrishMines commented Dec 16, 2024 •

edited

Loading

bparrishMines Jan 8, 2025 •

edited

Loading